All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class symantec.itools.awt.util.spinner.Spinner

Object
   |
   +----Component
           |
           +----Container
                   |
                   +----Panel
                           |
                           +----symantec.itools.awt.util.spinner.Spinner

public abstract class Spinner

extends Panel

implements Orientation, Serializable

Version:

1.1, June 2, 1997

Author:

Symantec

See Also:

ListSpinner, NumericSpinner

ORIENTATION_DEFAULT

The default spinner orientation.

action

An ActionEvent listener that handles typical spinner actions.

actionListener

The action listener which will receive action events from this component.

added

Tracks whether this component has been added to a container.

changes

Tracks listeners for all property change events.

current

The current spinner value.

currentVeto

A PropertyChangeEvent listener that constrains the "current" property as needed.

editable

Whether the Spinner's TextField is editable.

errors

Error reporting strings.

increment

The amount the spinner's value is changed when scrolling step is taken.

max

The maximum value the spinner may have.

maxVeto

A PropertyChangeEvent listener that constrains the "max" property as needed.

min

The minimum value the spinner may have.

minVeto

A PropertyChangeEvent listener that constrains the "min" property as needed.

orientation

Reserved.

text

Reserved.

textWidth

Reserved.

vetos

Tracks listeners for all vetoable property change events.

wrappable

Whether the value can wrap from max to min, and from min to max.

symantec.itools.awt.util.spinner.Spinner()

Constructs a default spinner.

addActionListener(ActionListener)

Adds the specified action listener to receive action events from this component.

addCurrentListener(PropertyChangeListener)

Adds a listener for the current property changes.

addCurrentListener(VetoableChangeListener)

Adds a vetoable listener for the current property changes.

addMaxListener(PropertyChangeListener)

Adds a listener for the max property changes.

addMaxListener(VetoableChangeListener)

Adds a vetoable listener for the max property changes.

addMinListener(PropertyChangeListener)

Adds a listener for the min property changes.

addMinListener(VetoableChangeListener)

Adds a vetoable listener for the min property changes.

addNotify()

Tells this component that it has been added to a container.

addPropertyChangeListener(PropertyChangeListener)

Adds a listener for all property change events.

addVetoableChangeListener(VetoableChangeListener)

Adds a listener for all vetoable property change events.

getCurrent()

Gets the current value of the spinner.

getCurrentText()

Gets the currently selected string from the list.

getDelay()

Returns the current delay between notification events of the spinner buttons in milliseconds.

getEditable()

getEntryFieldText()

Returns the text that is in the entry TextField.

getMax()

Gets the current maximum value the spinner may have.

getMin()

Gets the current minimum value the spinner may have.

getMinimumSize()

getNotifyWhilePressed()

getOrientation()

Gets whether the spinner buttons are laid out one above the other or one beside the other.

getPreferredSize()

getWrappable()

isEditable()

Returns whether the Spinner's TextField is editable.

isNotifyWhilePressed()

Gets the current notifyWhilePressed status.

isValidCurrentValue(int)

Is the given value valid for the Current property .

isValidMaxValue(int)

Is the given value valid for the Max property .

isValidMinValue(int)

Is the given value valid for the Min property .

isWrappable()

Gets whether the value can wrap from max to min, and from min to max.

removeActionListener(ActionListener)

Removes the specified action listener so it no longer receives action events from this component.

removeCurrentListener(PropertyChangeListener)

Removes a listener for the current property changes.

removeCurrentListener(VetoableChangeListener)

Removes a vetoable listener for the current property changes.

removeMaxListener(PropertyChangeListener)

Removes a listener for the max property changes.

removeMaxListener(VetoableChangeListener)

Removes a vetoable listener for the max property changes.

removeMinListener(PropertyChangeListener)

Removes a listener for the min property changes.

removeMinListener(VetoableChangeListener)

Removes a vetoable listener for the min property changes.

removeNotify()

Tells this component that it is being removed from a container.

removePropertyChangeListener(PropertyChangeListener)

Removes a listener for all property change events.

removeVetoableChangeListener(VetoableChangeListener)

Removes a listener for all vetoable property change events.

scrollDown()

Decrements the spinner's value and handles wrapping as needed.

scrollUp()

Increments the spinner's value and handles wrapping as needed.

setCurrent(int)

Sets the value of the spinner.

setDelay(int)

Sets the notification event delay of the spinner buttons in milliseconds.

setEditable(boolean)

Conditionally enables editing of the Spinner's TextField.

setEnabled(boolean)

setLayout(LayoutManager)

Takes no action.

setMax(int)

Sets the maximum value the spinner may have.

setMin(int)

Sets the minimum value the spinner may have.

setNotifyWhilePressed(boolean)

Sets whether the spinner buttons will continually post notify events while pressed.

setOrientation(int)

Sets whether the spinner buttons are laid out one above the other or one beside the other.

setWrappable(boolean)

Sets whether the value can wrap from max to min, and from min to max.

sourceActionEvent(String)

Fire an action event to the listeners

updateButtonStatus()

Handles enabling or disabling the spinner buttons as needed.

updateText(boolean)

Updates the text field with the current text, as needed or depending on the force flag.

validateText()

returns boolean if text in field is a valid entry

protected static int ORIENTATION_DEFAULT

The default spinner orientation.

protected symantec.itools.awt.util.spinner.Spinner. Action action

An ActionEvent listener that handles typical spinner actions.

protected java.awt.event.ActionListener actionListener

The action listener which will receive action events from this component.

See Also:

addActionListener, removeActionListener

protected boolean added

Tracks whether this component has been added to a container.

protected symantec.itools.beans.PropertyChangeSupport changes

Tracks listeners for all property change events.

See Also:

addPropertyChangeListener, removePropertyChangeListener

protected int current

The current spinner value.

See Also:

getCurrent, setCurrent

protected symantec.itools.awt.util.spinner.Spinner. CurrentVeto currentVeto

A PropertyChangeEvent listener that constrains the "current" property as needed.

See Also:

current, maxVeto, minVeto

protected boolean editable

Whether the Spinner's TextField is editable.

See Also:

isEditable, setEditable

protected java.util.ResourceBundle errors

Error reporting strings.

protected int increment

The amount the spinner's value is changed when scrolling step is taken.

See Also:

scrollUp, scrollDown

protected int max

The maximum value the spinner may have.

See Also:

getMax, setMax

protected symantec.itools.awt.util.spinner.Spinner. MaxVeto maxVeto

A PropertyChangeEvent listener that constrains the "max" property as needed.

See Also:

max, currentVeto, minVeto

protected int min

The minimum value the spinner may have.

See Also:

getMin, setMin

protected symantec.itools.awt.util.spinner.Spinner. MinVeto minVeto

A PropertyChangeEvent listener that constrains the "min" property as needed.

See Also:

min, currentVeto, maxVeto

protected int orientation

Reserved.

See Also:

getOrientation, setOrientation

protected java.lang.String text

Reserved.

protected int textWidth

Reserved.

protected symantec.itools.beans.VetoableChangeSupport vetos

Tracks listeners for all vetoable property change events.

See Also:

addVetoableChangeListener, removeVetoableChangeListener

protected boolean wrappable

Whether the value can wrap from max to min, and from min to max.

See Also:

isWrappable, setWrappable

public Spinner()

Constructs a default spinner. The current value is 0, the minimum value is 0, the maximum value is 1, the increment is 1, it is not wrappable, and has a vertical orientation.

public synchronized void addActionListener(ActionListener l)

Adds the specified action listener to receive action events from this component.

Parameters:

l - the action listener

See Also:

removeActionListener

public synchronized void addCurrentListener(PropertyChangeListener listener)

Adds a listener for the current property changes.

Parameters:

listener - the listener to add.

See Also:

removeCurrentListener(java.beans.PropertyChangeListener)

public synchronized void addCurrentListener(VetoableChangeListener listener)

Adds a vetoable listener for the current property changes.

Parameters:

listener - the listener to add.

See Also:

removeCurrentListener(java.beans.VetoableChangeListener)

public synchronized void addMaxListener(PropertyChangeListener listener)

Adds a listener for the max property changes.

Parameters:

listener - the listener to add.

See Also:

removeMaxListener(java.beans.PropertyChangeListener)

public synchronized void addMaxListener(VetoableChangeListener listener)

Adds a vetoable listener for the max property changes.

Parameters:

listener - the listener to add.

See Also:

removeMaxListener(java.beans.VetoableChangeListener)

public synchronized void addMinListener(PropertyChangeListener listener)

Adds a listener for the min property changes.

Parameters:

listener - the listener to add.

See Also:

removeMinListener(java.beans.PropertyChangeListener)

public synchronized void addMinListener(VetoableChangeListener listener)

Adds a vetoable listener for the min property changes.

Parameters:

listener - the listener to add.

See Also:

removeMinListener(java.beans.VetoableChangeListener)

public synchronized void addNotify()

Tells this component that it has been added to a container. This is a standard Java AWT method which gets called by the AWT when this component is added to a container. Typically, it is used to create this component's peer. It has been overridden here to hook-up event listeners. It is also used to setup the component, creating the TextField as needed.

Overrides:

addNotify in class Panel

See Also:

removeNotify

public synchronized void addPropertyChangeListener(PropertyChangeListener listener)

Adds a listener for all property change events.

Parameters:

listener - the listener to add

See Also:

removePropertyChangeListener

public synchronized void addVetoableChangeListener(VetoableChangeListener listener)

Adds a listener for all vetoable property change events.

Parameters:

listener - the listener to add

See Also:

removeVetoableChangeListener

public int getCurrent()

Gets the current value of the spinner.

Returns:

the current spinner value

See Also:

setCurrent

protected abstract java.lang.String getCurrentText()

Gets the currently selected string from the list.

Returns:

the string currently visible in the Spinner

See Also:

updateText(boolean)

public int getDelay()

Returns the current delay between notification events of the spinner buttons in milliseconds.

See Also:

setNotifyWhilePressed, setDelay

public boolean getEditable()

Note: getEditable() is deprecated.

See Also:

isEditable

public java.lang.String getEntryFieldText()

Returns the text that is in the entry TextField.

public int getMax()

Gets the current maximum value the spinner may have.

Returns:

the current maximum value

See Also:

setMax

public int getMin()

Gets the current minimum value the spinner may have.

Returns:

the current minimum value

See Also:

setMin

public java.awt.Dimension getMinimumSize()

Overrides:

getMinimumSize in class Container

public boolean getNotifyWhilePressed()

Note: getNotifyWhilePressed() is deprecated.

See Also:

isNotifyWhilePressed

public int getOrientation()

Gets whether the spinner buttons are laid out one above the other or one beside the other.

Returns:

the orientation, one of: ORIENTATION_VERTICAL, or ORIENTATION_HORIZONTAL

See Also:

setOrientation, ORIENTATION_VERTICAL, ORIENTATION_HORIZONTAL

public java.awt.Dimension getPreferredSize()

Overrides:

getPreferredSize in class Container

public boolean getWrappable()

Note: getWrappable() is deprecated.

See Also:

isWrappable

public boolean isEditable()

Returns whether the Spinner's TextField is editable.

Returns:

true if the TextField can be edited, false otherwise

See Also:

setEditable

public boolean isNotifyWhilePressed()

Gets the current notifyWhilePressed status.

Returns:

true if notify events posted while pressed, false otherwise

See Also:

setNotifyWhilePressed, setDelay, getDelay

protected boolean isValidCurrentValue(int i)

Is the given value valid for the Current property .

Parameters:

i - the given value

Returns:

true if the given value is acceptable, false if not.

protected boolean isValidMaxValue(int i)

Is the given value valid for the Max property .

Parameters:

i - the given value

Returns:

true if the given value is acceptable, false if not.

protected boolean isValidMinValue(int i)

Is the given value valid for the Min property .

Parameters:

i - the given value

Returns:

true if the given value is acceptable, false if not.

public boolean isWrappable()

Gets whether the value can wrap from max to min, and from min to max.

Returns:

true if the value is allowed to wrap

See Also:

setWrappable

public synchronized void removeActionListener(ActionListener l)

Removes the specified action listener so it no longer receives action events from this component.

Parameters:

l - the action listener

See Also:

addActionListener

public synchronized void removeCurrentListener(PropertyChangeListener listener)

Removes a listener for the current property changes.

Parameters:

listener - the listener to remove.

See Also:

addCurrentListener(java.beans.PropertyChangeListener)

public synchronized void removeCurrentListener(VetoableChangeListener listener)

Removes a vetoable listener for the current property changes.

Parameters:

listener - the listener to remove.

See Also:

addCurrentListener(java.beans.VetoableChangeListener)

public synchronized void removeMaxListener(PropertyChangeListener listener)

Removes a listener for the max property changes.

Parameters:

listener - the listener to remove.

See Also:

addMaxListener(java.beans.PropertyChangeListener)

public synchronized void removeMaxListener(VetoableChangeListener listener)

Removes a vetoable listener for the max property changes.

Parameters:

listener - the listener to remove.

See Also:

addMaxListener(java.beans.VetoableChangeListener)

public synchronized void removeMinListener(PropertyChangeListener listener)

Removes a listener for the min property changes.

Parameters:

listener - the listener to remove.

See Also:

addMinListener(java.beans.PropertyChangeListener)

public synchronized void removeMinListener(VetoableChangeListener listener)

Removes a vetoable listener for the min property changes.

Parameters:

listener - the listener to remove.

See Also:

addMinListener(java.beans.VetoableChangeListener)

public synchronized void removeNotify()

Tells this component that it is being removed from a container. This is a standard Java AWT method which gets called by the AWT when this component is removed from a container. Typically, it is used to destroy the peers of this component and all its subcomponents. It has been overridden here to unhook event listeners.

Overrides:

removeNotify in class Container

See Also:

addNotify

public synchronized void removePropertyChangeListener(PropertyChangeListener listener)

Removes a listener for all property change events.

Parameters:

listener - the listener to remove

See Also:

addPropertyChangeListener

public synchronized void removeVetoableChangeListener(VetoableChangeListener listener)

Removes a listener for all vetoable property change events.

Parameters:

listener - the listener to remove

See Also:

addVetoableChangeListener

protected void scrollDown()

Decrements the spinner's value and handles wrapping as needed.

See Also:

scrollUp, increment

protected void scrollUp()

Increments the spinner's value and handles wrapping as needed.

See Also:

scrollDown, increment

public void setCurrent(int i) throws PropertyVetoException

Sets the value of the spinner.

Parameters:

i - the new value

Throws: PropertyVetoException

if the specified property value is unacceptable

See Also:

getCurrent

public void setDelay(int d) throws PropertyVetoException

Sets the notification event delay of the spinner buttons in milliseconds.

Parameters:

d - the delay between notification events in milliseconds

Throws: PropertyVetoException

if the specified property value is unacceptable

See Also:

setNotifyWhilePressed, getDelay

public void setEditable(boolean f) throws PropertyVetoException

Conditionally enables editing of the Spinner's TextField.

Parameters:

f - true = allow editing; false = disallow editing

Throws: PropertyVetoException

if the specified property value is unacceptable

public void setEnabled(boolean f)

Overrides:

setEnabled in class Component

public void setLayout(LayoutManager lm)

Takes no action. This is a standard Java AWT method which gets called to specify which layout manager should be used to layout the components in standard containers. Since layout managers CANNOT BE USED with this container the standard setLayout has been OVERRIDDEN for this container and does nothing.

Parameters:

lm - the layout manager to use to layout this container's components (IGNORED)

Overrides:

setLayout in class Container

See Also:

getLayout

public void setMax(int i) throws PropertyVetoException

Sets the maximum value the spinner may have.

Parameters:

i - the new maximum value

Throws: PropertyVetoException

if the specified property value is unacceptable

See Also:

getMax

public void setMin(int i) throws PropertyVetoException

Sets the minimum value the spinner may have.

Parameters:

i - the new minimum value

Throws: PropertyVetoException

if the specified property value is unacceptable

See Also:

getMin

public void setNotifyWhilePressed(boolean f) throws PropertyVetoException

Sets whether the spinner buttons will continually post notify events while pressed.

Parameters:

f - true = send messages; false = do not send messages

Throws: PropertyVetoException

if the specified property value is unacceptable

See Also:

isNotifyWhilePressed, setDelay, getDelay

public void setOrientation(int o) throws PropertyVetoException

Sets whether the spinner buttons are laid out one above the other or one beside the other.

Parameters:

o - the new orientation, one of: ORIENTATION_VERTICAL, or ORIENTATION_HORIZONTAL

Throws: PropertyVetoException

if the specified property value is unacceptable

See Also:

getOrientation, ORIENTATION_VERTICAL, ORIENTATION_HORIZONTAL

public void setWrappable(boolean f) throws PropertyVetoException

Sets whether the value can wrap from max to min, and from min to max.

Parameters:

f - true to allow the value to wrap

Throws: PropertyVetoException

if the specified property value is unacceptable

See Also:

isWrappable

protected void sourceActionEvent(String s)

Fire an action event to the listeners

protected void updateButtonStatus()

Handles enabling or disabling the spinner buttons as needed.

protected void updateText(boolean force)

Updates the text field with the current text, as needed or depending on the force flag.

Parameters:

force - If true, causes the text field to update even if the value has not changed.

See Also:

getCurrentText

protected boolean validateText()

returns boolean if text in field is a valid entry

Returns:

true if text is valid

All Packages  Class Hierarchy  This Package  Previous  Next  Index